home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
wildcat
/
upage10.zip
/
UNIPAGE.DOC
< prev
next >
Wrap
Text File
|
1992-09-22
|
32KB
|
893 lines
╖ ┌ ╥─┐ ╥ ╥─┐ ╓─┐ ╓─┐ ╥─┐
║ │ ║ │ ║ ╟─┘ ╟─┤ ║ ┬ ╟─
╙─┘ ╨ ┴ ╨ ╨ ╜ └ ╙─┘ ╨─┘
The Universal Paging System
version 1.0
by Michael Wilson
The Village
408-229-0706
USR Courier HST Dual Standard
1200/2400/9600/16.8K
24 hours / 7 days
CONTENTS
════════
I. Introduction
a. Overview
b. Background
c. Tools
d. Restrictions in the unregistered version
e. Benefits of registering
f. Support
II. Setup
a. Supported BBS Systems
b. Customization of the menu
c. Configuration File
d. Page Options
e. Reasons.dat file
f. Comment.ans
g. Local Mode
h. Multi-Node Support
III. Use
a. Keys to use while chatting
b. On-Line Sysop Keys
IV. Compufax Software
V. Registration Information and Form
VI. Bug report form
VII. Revision History
INTRODUCTION
════════════
Overview
────────
UNIPAGE is the complete page/chat door. It presents the caller with a
custom menu or "Reasons" for the page. The caller is then forced to enter
a one line summary of the Reason. UNIPAGE can branch to different
functions depending on the "reason" for the page. UNIPAGE has 6 different
page tones, can "silent" page, can ask the caller to leave a comment, and
can shell to another door (like Shampage or a questionaire).
* Fully configurable
- Reasons
- Main Menu
- Tones
- Times for no bell, comment only and shell only
* Support for all known and unknown comm ports
* Fossil driver support
* Complete monitoring of system time, time left, carrier and DTE
* Support for color and mono screens
* A variety of "hot-keys" to use while the caller is on-line
Background
──────────
The idea for this door came after months of looking for a good page door.
When a caller pages me, I want to know who it is, and why they are paging
me before I answer. I am a supportive sysop, and I got tired of answering
a page at 10:00pm just to have the caller say "I'm bored and wanted to
talk". I reviewed dozens of page doors, and they all were worthless. So,
as with most software I write, I wrote UNIPAGE to fill my need, I hope it
works for you.
Tools
─────
Language and Compiler: Borland C 3.1
Editor: Multi-Edit 6.00cP
Libraries: CKit Door Library 2.11
Version Control: Sage's PVCS
Beta Test: The Haunted Castle BBS (Spitfire)
408-226-1052
The Village (Wildcat)
408-229-0706
Tea: Earl Grey, Hot (Bigelow)
Restrictions in the unregistered version
────────────────────────────────────────
This door is fully functional in the unregistered version. However, there
will be a pause at the beginning and the end in the unregistered mode.
You may also not change line 6, 14 and 15 in the configuration file.
Benefits of registering
───────────────────────
1. All delays and reminders are removed.
2. A 1 year membership in The Village BBS.
3. All future updates FREE, downloaded from The Village BBS.
4. Ability to change lines 6, 14 and 15 in the config file
file.
Support
───────
I will not accept voice phone calls, but can be reached at the following
locations:
Snail-Mail: Compufax Consulting Services
7145 Aptos Beach Court
San Jose, CA 95139
BBS: The Village
408-229-0706
USR Courier HST Dual Standard 16.8
Leave comment for the SYSOP in the Main Conference [000]
CompuServe: 76207,1673
Please include all available information including copies of your
UNIPAGE.CFG files.
The latest version will always be available on the following boards:
The Village:
408-229-0706
USR Courier HST Dual Standard 16.8
Michael Wilson, sysop
The Haunted Castle BBS:
408-226-1052
USR Courier HST Dual Standard 14.4
David Clifford, sysop
CompuServe: IBM BBS Forum (GO IBMBBS), Doors Library
SETUP
═════
Supported BBS Systems
─────────────────────
UNIPAGE will support any BBS that creates a DOOR.SYS file when
chaining to a door. Also, Wildcat 2.x (CALLINFO.BBS) and PC Board - 12.x
through 14.x (PCBOARD.SYS) are supported.
Customization of the Game
─────────────────────────
The following UNIPAGE Features are fully customizable by you so
that you can make your own distinct page door:
* The "Reasons" menu
* The opening greeting
* The Closing goodbye
* The number of page cycles
* The sound of the page bell
* Which reasons are silent, which ask for a comment, which shell
* Times where all bells are silent, all reasons ask for a comment and
all reasons shell
* The shell program
* Split or normal chat screen
CONFIGURATION FILE
══════════════════
UNIPAGE knows what type of system you are using, and what to do through a
configuration file. The configuration file can have any legal DOS
filename. It consists of 16 lines as follows:
line 1: c:\door\door.sys
line 2: The Village
line 3: Michael Wilson
line 4: 0000000000
line 5: UNIPAGE.LOG
*line 6: 10
line 7: SPLIT
line 8: BELL,4
line 9: BELL,1
line 10: 00:00-00:00
line 11: 00:00-00:00
line 12: 00:00-00:00
line 13: SHAMpage SHAMpage.cfg
*line 14: Hello *USER*, Can I help You?
*line 15: Nice chatting with you, *USER*
line 16: NONE
*These items cannot be changed in the UNREGISTERED version.
NOTE: The line numbers are only listed for clarity. Your configuration
file will have no line numbers listed
LINE 1: This is the complete drive letter, path and filename of your
BBS door system file. This can be either DOOR.SYS,
CALLINFO.BBS or PCBOARD.SYS.
LINE 2: This is the name of your BBS. It must EXACTLY match the name
of the BBS you put on the registration form. Upper and lower
case make a difference here. This name will be displayed
EXACTLY as entered here when the door is registered.
LINE 3: This is the name of the sysop. This name must EXACTLY match
the name entered on the registration form. Upper and lower
case make a difference. This name will be displayed as the
sysop when the door is registered.
LINE 4: The registration number obtained when you register.
LINE 5: This is the complete path and file name of your log file (128
characters). Each time a person enters the door, an entry will be
made in the log file with their name, the time, the reasons for
the page, and other information. The information is appended to
the end of the log file for each caller.
LINE 6: This is the number of page cycles that will be performed before
UNIPAGE gives up and assumes you are not available. A page cycle
is equal to the number of beeps you hear (or beep sets). Each
cycle is approximately 1.5 seconds.
LINE 7: This is the type of chat screen. The choices are SPLIT or LINE.
A split screen chat will have all the local input be in the top
half of the screen, and the remote input will be in the bottom
half. This is a much better way to keep the two inputs separate,
and allows both parties to type at the same time, and not get the
words mixed up. LINE mode is just adding lines of input one after
another, scrolling the screen when you hit the bottom. This is
not a good choice because you can overtype your callers words.
LINE Mode must be used if the caller does not have ANSI active.
You can have SPLIT here, but UNIPAGE will automatically select
LINE if ANSI is not detected.
LINE 8: You can designate what your Emergency Page (#1) will do here. The
options are BELL,#; NOBELL; COMMENT; and SHELL. See the following
section for more information on these options.
LINE 9: This line sets up your Chit Chat Page Options (#2), see the
following section for more information on page options.
LINE 10: This is the time where all pages will be NOBELL. What this means
is that all pages that occur during these hours will not sound
the bell, no matter how you had them setup. The time is entered
as HH:MM-HH:MM (i.e.: 22:30-06:00). All time must be in 24 hour
military time. In the above example, all pages that occur
between 11:30pm and 6:00am will not sound the bell.
LINE 11: This line sets up the times for all pages to request a comment.
Like line 10, the time is entered in 24 hour military time. Any
page that occurs during this time will tell the caller you are
unavailable, and request a comment.
LINE 12: This line sets the time when every page will be Shelled to the
SHELL program. I use SHAMpage for this, and have every caller
who calls between 01:00 and 03:00 talk to SHAMpage. I think it's
the best way to answer a page, and not wake up. Follow the same
rules as lines 10 and 11.
LINE 13: This is your shell program. You can use any door or
communications program as your shell. UNIPAGE shells out of
memory to start your shell program, and comes back when your
shell exits to cleanly exit UNIPAGE. For C programers out there,
I am using spawnlp for the shell.
You must enter the complete filename with extension, plus all
command line parameters, separated by spaces. To use SHAMpage,
use the following line:
SHAMPAGE.EXE SHAMPAGE.CFG
You are limited to 128 characters for this line. If you use
SHAMpage, the SHAMpage files must be in the UNIPAGE directory.
The shell will search the path for your executable, or you can
enter an explicate path.
LINE 14: This line is your opening line. This line, exactly as you type
it, will be displayed to the user as soon as you enter chat. You
can use the variable *USER* anywhere in the greeting, and it will
be replaced with the caller's first name when displayed.
LINE 15: This line is your exit message. This line will be displayed,
exactly as you typed it in, to the caller as you exit chat. The
variable *USER* can be used anywhere in the line, and will be
replaced with the caller's first name when displayed.
LINE 16: This line of for non-standard comm port parameters. If you do
not use a standard comm port setup, then the syntax is
PORT:AAAA:X where AAAA is the base address and X is the IRQ.
UNIPAGE will also support the use of FOSSIL drivers. The
syntax for a FOSSIL driver is: PORT:F:P. The 'F' tells UNIPAGE
to use a Fossil driver for it's communications. The 'P'
following it tells it which port to use for the Fossil.
Example - PORT:F:1, tells UNIPAGE to use a fossil driver for
port 1. If you use a standard port setup, place the word NONE
here.
Some Thought on Setting Times (Config lines 10, 11 and 12 )
─────────────────────────────
The times for NOBELL, COMMENT and SHELL can overlap. The order of
checking for these times is: SHELL then COMMENT then NOBELL. What this
means is that if you had the following in your config file:
LINE 10: 20:30-08:00 (No Bell)
LINE 11: 23:30-06:30 (Comment)
LINE 12: 01:00-04:30 (Shell);
Pages from 20:30 - 23:30 would have no bell
Pages from 23:30 - 01:00 would be asked to leave a comment
Pages from 01:00 - 04:30 would be shelled
Pages from 04:30 - 06:30 would be asked to leave a comment
Pages from 06:30 - 08:00 would have no bell
Pages from 08:00 - 20:30 would be normal pages
PAGE OPTIONS
════════════
You can tell UNIPAGE to branch and perform various actions based on the
reason the caller gives for the page. The branching commands are:
BEEP,#
NOBEEP
COMMENT
SHELL
These are used in lines 8 and 9 of the configuration file and each line in
REASONS.DAT (discussed below). The options do the following:
BEEP,#: This option will beep your computers speaker to notify you have a
page. This is the best way to know someone is paging you. The # must
follow the word BEEP with a comma, and no spaces. The # is a number from
1 to 5 which corresponds to one of the built in page bells. UNIPAGE
contains 5 different page tones, and you can customize each reason to have
a different tone. In this way, you can tell what the caller wants just be
hearing the tone.
An example would be BEEP,3. This would use the page bell, using tone
number 3. Use the sample program PAGETEST.EXE to sample the various
tones.
NOBEEP: This will display the PAGING: * * * *, message on the screen
telling you that you are being paged, but will make no sound.
COMMENT: This will automatically tell the caller that you are
unavailable, and it will ask them to leave a comment. This will not
notify you in nay way that you are being paged.
SHELL: This will hand the caller off to your shell program, without any
notification to you or them. It will be as if the shell program is a
seamless part of UNIPAGE.
REASONS.DAT
═══════════
The REASONS.DAT file is optional. UNIPAGE has 2 built in page
reasons: Emergency and Chit Chat. You can add up to 7 more reasons.
Your custom reasons will appear on the main menu, as part of the program.
The caller will not see a difference between the built in options and your
custom options. The format for the Reasons.dat is 1 entry per line as
follows:
System Bug Report,BEEP,2
This line would be decoded like this. "System Bug Report" will appear on
the menu as a reason for paging. If chosen, the page bell will sound,
using tone 2. Other examples are:
Just to bug the sysop,COMMENT
This would have the phrase "Just to bug the sysop" on the menu, and would
ask the caller for a comment if this reason is chosen.
There can be no spaces between the phrase, comma, and page option. The
following are legal lines in REASONS.DAT:
Talk to SHAMpage,SHELL
I'm Lost and need help,BEEP,5
I need to talk to someone,NOBEEP
I've fallen and can't get up,BEEP,1
COMMENT.ANS
═══════════
You may create an ANSI graphic picture to display to callers when you are
not available. It needs to be called COMMENT.ANS, and must be in the same
directory as UNIPAGE.EXE. This will be displayed whenever the comment
page option is used, the comment time is in force or you fail to answer a
page. It will only be displayed to callers who have ANSI Graphics
enabled. A default text message asking them to leave a comment will be
displayed if this file does not exist or the caller does not have ANSI
enabled.
Sample Door Batch File
──────────────────────
The configuration filename is placed on the command line of
UNIPAGE.EXE. Here is a sample batch file to give you an idea of
how the door is called:
C:
CD\UNIPAGE
UNIPAGE UNIPAGE.CFG
CD\
If the configuration file is missing, or incorrectly made, an error
will be displayed.
For Wildcat 3.x installation, enter MakeWild and go to the Main Menu page.
Find the option for [P]age sysop, and change the "hot-key" letter to 'Z'
or some other unused letter. Raise the security level of this option to
1000. Find the DOS Hook 1, or 2 if 1 is being used. Change the "hot-key"
letter to P, and make the security level low enough so anyone can use it.
You must name your batch file MAIN1.BAT (for DOS hook 1), or MAIN2.BAT
(for DOS hook 2, and these batch files must be in your HOME directory
(C:\WC30). Now users will get UNIPAGE everytime they want to page you!
Local Mode
──────────
The door can be tested in Local Mode, although, you'll have to talk to
yourself, by having the config file point to a BBS door file that has a
comm port of zero (COM0:). Included are the following files:
LOCAL.BAT
LOCAL.CFG
DOOR.SYS
These will assist you in testing the door in local mode. If you want your
name displayed instead of "SYSOP", edit DOOR.SYS and replace the word
SYSOP with your name.
Simply typing LOCAL with the above files in the current directory,
therefore, will put the door in local mode.
MULTI-NODE SUPPORT
══════════════════
UNIPAGE does not support true on-line interactive chat between two
callers, but it does support multi-line. What this means is that 2
callers may be chating with the sysop at the same time, and all files will
be updated on-the-fly.
The main setup difference from single to multi-node is the configuration
file. Since the first line points to your door information file, you must
have a different config file for each door information file. All the
other lines should remain the same (unless you want different page tones
for each node)
Do whatever you must do to start your multiple nodes, and have a different
batch file for each UNIPAGE.
There are plans for an interactive char mode between 2 or more remote
people, but it is far from ready.
PAGETEST.EXE
════════════
PAGETEST.EXE is a small program that will allow you to preview the page
bells. Simply type PAGETEST <return>, then enter the number of the
various page bells, and listen. Each bell can be stopped by pressing any
key. This program is not required for operation of UNIPAGE. It is
supplied so that you can hear the page bells without a great deal of
difficulty and setup.
Keys to Use While Chatting
──────────────────────────
The keys listed under On-Line Sysop Commands will work while the user is
in any part of UNIPAGE. The following keys, however, are specific to the
time you are chating with the caller.
Ctrl-C: This will clear the screen, redraw the dividing line (in split
mode), and position the curosr in the upper left hand corner of each
section. This is usefull if a blast of line noise or something like that
occurs.
Ctrl-S: This will switch between Split-Screen chat and line chat, and back
from line-chat to Split-Screen chat. whichever mode you are in, Ctrl-S
will switch to the other one.
Ctrl-U: This will display a very short user stats screen for the person
you are chatting with. It will be inthe upper area, and only on the local
screen (The other person can't see it)
Ctrl-X: This will immediately return the caller to your BBS, exiting chat
without any closing message (config line 15), pause, delay or other
notification.
Ctrl-Z: This key will drop carrier, and take the phone off-hook, kicking
the user out of the door, and hanging up the phone on them. Obviously,
this is to be used only in extreme cases. Also, make sure that your BBS
system can handle dropped carrier inside of a door, because that's all it
will see.
ESC: This will end chat, send your closing message (config line 15), and
exit the door normally. The caller will then be returned to your BBS to
continue as they wish. This is the way most callers will be exited from
chat.
On-Line Sysop Commands
──────────────────────
While a caller is on-line, the local sysop has several options. They are
as follows:
Function key
------------
F5 Shell to DOS
F8 Return user to system
F9 Toggle display on/off
* F3 Toggle printer on/off
* F4 Toggle pagebell on/off
* F7 Toggle caller alarm on/off
Alternate key
-------------
ALT-H Toggle between different status lines
* ALT-N Toggle sysop on next
* ALT-X Toggle exit to dos after call
and help lines
Alternately pressing the ALT-H key will bring up
the next status line screen. The 1st screen is a help screen,
the second screen shows your COM port status.
* The function keys marked with an "*" will only be of use to systems
using pcboard.sys. The rest are functional with any system.
COMPUFAX SOFTWARE
═════════════════
Compufax Software is a division of Compufax Consulting Services. We
specialize in getting the right computer and software for your needs. All
of our work is custom and created just for you.
We started writing door software with a program called BUY&SELL Door.
After reviewing dozens of For Sale Doors, we could not find one to meet our
needs, so we wrote one. That is what we do. We find a need, and write a
door to fill that. You won't find us writing 30 card game doors that all
look the same. Each door is individually designed to meet a need.
Currently, we have 3 BBS door programs:
Food Fight
Buy & Sell
UNIPAGE
We will not cripple our doors. We'll just put in a few seconds reminder
that this copy is unregistered. We will never write a door that expires.
We have over 60 doors on our board, and sometimes it is month before a
door is fully tested. We won't force you to download a demo key every few
weeks either. Everything you need for full operation of our doors is
included in the distribution zip. No runtime modules, no keys, nothing
extra, nothing more to download.
All of our doors have a simple to use Local mode. You can see the program
before you put it online.
Your registrations are forever. When we give you a registration number,
you will never need to buy anything ever again. Each new version will use
the same number, and your registered for life.
You can receive free technical support even if you are not a registered
user. Because of my schedule, I cannot be available for voice support,
but I'll answer every message on my BBS and Compuserve. If you need to
talk to me voice, I'll be happy to make an appointment and call you.
We're tired of poorly programmed, boring BBS Doors. We are here to change
all that. We may not have 30 door, but the few we have are the best!
REGISTRATION
════════════
When you register UNIPAGE, your registration number will be posted on
The Village BBS (408-229-0706), in a private message to you. You
should allow 1 week from the time you send your check before the
message is posted. Other options include sending you the number and
sending you the latest version of the program with the number.
NOTE: The latest version may not be later than the one you have, and no
version number verification will be performed..
UNIPAGE REGISTRATION FORM
═════════════════════════
Your BBS Number (so I can call and play):________________
Name: ___________________________________________________
(Your name here must match EXACTLY with the name entered
on line 3 of the config file. Upper and lower case make a
difference here. Print or type clearly.)
BBS Name: _______________________________________________
(Your BBS name here must match EXACTLY with the BBS name
entered on line 2 of the config file. Upper and lower case
make a difference here. Print or type clearly.)
The name you have used or wish to use to log into The Village BBS:
_________________________________________________________________
╔════════════════════════════════════════════════════════════╗
║ ║
║ If you do not have a login to my board, and wish me to set ║
║ one up for you, supply the following information: ║
║ ║
║ ║
║ Phone number (with area code): __________________________ ║
║ ║
║ Birthday: _______________________________________________ ║
║ ║
║ Password: _______________________________________________ ║
║ ║
╚════════════════════════════════════════════════════════════╝
If you wish me to send you the registration number of the latest
version of UNIPAGE, fill out the following:
Address:____________________________________________________
____________________________________________________
____________________________________________________
Mail To: Compufax Consulting Services
7145 Aptos Beach Court
San Jose, CA 95139
Select which option you would like to register UNIPAGE:
Basic Registration.
Includes lifetime registration number posted
to The Village BBS in a private message to you....$20.00 _____
Mail Number.
Includes lifetime registration number mailed
to you at the above address.......................$22.50 _____
Mail Diskette.
Includes lifetime registration number mailed
to on a diskette, along with the latest version
of this software..................................$27.00 _____
Type of diskette: *5.25" High Density _____
5.25" Low Density _____
*3.5" High Density _____
3.5" Low Density _____
*If you choose a High Denisty diskette, you will get
sample of other Compufax Software on the same disk
Total Enclosed: __________
Payment method:
[ ] Check made payable to Compufax Consulting Services.
[ ] VISA [ ] Master Card [ ] Discover [ ] Carte Blanche
[ ] JCB [ ] Diner's Club
For Credit Card Purchases:
Number:________________________________Ex Date:_________________
Name on card:___________________________________________________
Statement ______________________________________________________
Mailing
Address:______________________________________________________
______________________________________________________
Home Phone:_____________________ Work Phone:____________________
Signature:______________________________________________________
R E G I S T E R O N L I N E
═════════════════════════════
You can register this software On-Line on the Village BBS. From the main
menu, Choose [Q]uestionnaires, and choose questionnaire number 6. Have
your charge card ready.
We accept VISA, Master Card, Discover, Diner's Club, Carte Blanche and
JCB cards.
Due to the nature of your purchase, your registration number will be
available within 12 hours of you completing the questionnaire.
BUG REPORT
══════════
Please report any and all bugs to my. Include as much information as you
can. If I think I have fixed it, I will send you the new version
for free, for testing.
You may use the form below to report any bugs, or use your own form.
Please send the form to me, or upload it to my BBS.
Explain the bug:____________________________________________________
____________________________________________________________________
____________________________________________________________________
____________________________________________________________________
____________________________________________________________________
____________________________________________________________________
____________________________________________________________________
____________________________________________________________________
____________________________________________________________________
____________________________________________________________________
____________________________________________________________________
____________________________________________________________________
____________________________________________________________________
(use another sheet of paper if needed)
Your BBS number:____________________________________________________
Version of UNIPAGE:________________________________________________
DOS Date and time of UNIPAGE.EXE:__________________________________
BBS Software and version:___________________________________________
Describe your machine:______________________________________________
____________________________________________________________________
Describe your multi-tasking, if any:________________________________
____________________________________________________________________
Is this multi-node? (how many)______________________________________
Please include copies of your UNIPAGE.CFG, and UNIPAGE.LOG.
REVISION HISTORY
════════════════